Wie kann ich eine Quick-Info zur Dokumentation eines ST-Elements erstellen?
Im ST-Editor wird eine Quick-Info zur Dokumentation für ein Element angezeigt, falls Sie den Mauszeiger auf dieses Element bewegen. Die Quick-Info wird oft auch als "Tooltip" oder "Hover-Text" bezeichnet.
Beispiel für eine Quick-Info zu einer Variable:
Sie können bestimmen, welcher Text in der Quick-Info für benutzerdefinierte Elemente angezeigt wird:
-
Positionieren Sie auf das benutzerdefinierte Element, für das Sie eine Quick-Info einfügen oder ändern möchten. Falls es sich dabei nicht um die Deklaration handelt, gehen Sie zu seiner Deklaration: Kontextmenü im ST-Editor, Deklaration öffnen
-
Vor der Deklaration des Elements geben Sie einen Kommentar ein. Der Kommentar kann ein- oder mehrzeilig sein.
Falls Sie den Text formatieren wollen, geben Sie die entsprechenden HTML-Tags ein (z.B.<br>
für einen Zeilenumbruch). Ausreichende Dokumentation der HTML-Tags finden Sie im Internet.
Beispiel für Kommentar vor der deklarierten VariableInit
:VAR
/* 'Init' is set to '<b>TRUE</b>' when the program is started. <br>
* Then 'Init' is used to initialized the hardware.
*/
Init : BOOL;
END_VAR
-
Gehen Sie zurück zur Verwendung (z.B. mit der Methode "Verweise für ein Element finden") und zeigen Sie auf das Element, um die neue/geänderte Quick-Info anzuzeigen. Oder zeigen Sie gleich auf das deklarierte Element.
Beispiel für die geänderte Quick-Info: